DiscoverNetworkServers(IEasyUAClient,IEnumerable<String>,String,Boolean) Method

Discovers available OPC-UA servers on the network and returns information about them, using the specified discovery host, specifying the capabilities that the servers must have, and whether the results should be flat.

Syntax

[Extension()]
[NotNull()]
public static UADiscoveryElementCollection DiscoverNetworkServers( 
   IEasyUAClient client,
   IEnumerable<string> serverCapabilityFilter,
   string discoveryHost,
   bool flat
)

[Extension()]
[NotNull()]
public:
static UADiscoveryElementCollection^ DiscoverNetworkServers( 
   IEasyUAClient^ client,
   IEnumerable<String^>^ serverCapabilityFilter,
   String^ discoveryHost,
   bool flat
)

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function DiscoverNetworkServers( _
   ByVal client As IEasyUAClient, _
   ByVal serverCapabilityFilter As IEnumerable(Of String), _
   ByVal discoveryHost As String, _
   ByVal flat As Boolean _
) As UADiscoveryElementCollection

'Usage
 
Dim client As IEasyUAClient
Dim serverCapabilityFilter As IEnumerable(Of String)
Dim discoveryHost As String
Dim flat As Boolean
Dim value As UADiscoveryElementCollection
 
value = IEasyUAClientExtension.DiscoverNetworkServers(client, serverCapabilityFilter, discoveryHost, flat)

Parameters

client

The client object that will perform the operation.

This is typically the EasyUAClient object.

The value of this parameter cannot be null (Nothing in Visual Basic).

serverCapabilityFilter

List of Server capability filters. Only records with all the specified server capabilities are returned.

The value of this parameter cannot be null (Nothing in Visual Basic).

discoveryHost

The name of the machine that runs the discovery server that will be used for discovery task.

The value of this parameter cannot be null (Nothing in Visual Basic).

flat

Determines whether one element will be returned for each discovery URI.

Return Value

Returns a collection of application elements (servers, OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement).

This method never returns null (Nothing in Visual Basic).

The individual elements of the returned value are never null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

When the flat parameter is false, the discovery query returns one OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement for each application found, and its OpcLabs.EasyOpc.UA.Discovery.IUAReadOnlyApplicationElement.DiscoveryUriStrings property contains one or more application discovery URLs.

When the flat parameter is true, the discovery query returns one OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement for each discovery URL of each application found. In this case, the OpcLabs.EasyOpc.UA.Discovery.IUAReadOnlyApplicationElement.DiscoveryUriStrings property of each returned application element contains precisely one string, and you can therefore use the OpcLabs.EasyOpc.UA.Discovery.IUAReadOnlyApplicationElement.DiscoveryUriString property instead to obtain the discovery URL.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IEasyUAClientExtension Class
IEasyUAClientExtension Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support